Health service URI has additional query parameters to enable users to query for specific type of entity and asset. During API validation, the query parameters are validated and an appropriate response is returned. Check the REST API guide for the different status and responses.
| Category | API | Description | ||
|---|---|---|---|---|
| Health – Configuration Information |
GET /healthmanager/health/inventory |
Displays a list of contributor resources |
||
| Health – Operational Information |
GET /healthmanager/health/detail ? resource=<resource path> |
Gets Health
|
||
| Health – Operational Information | GET /healthmanager/health ? resource=<resource path> & detail=<true | false> |
Displays a list of resources with a health score contributing to overall health. |
The following table describes commands to clear the health of a subtree for the specified resource:
| Category | CLI | Description |
|---|---|---|
| Health – Configuration Information |
Command Syntax: efa health debug clear --resource /App/Asset |
Optional –resource If a resource is not specified, the command clears the health of the tree from the Root node, for example, “/”. If a resource is specified, the command clears the health of the subtree for a specified resource |
Response
{
Resource: /App
HQI {
Color: Yellow
Value: 2
}
StatusText: [<Freeform status text>]
}
Response
{
Resource: /App
HQI {
Color: Yellow
Value: 2
}
Contributor {
ResourceList: [/App/System/Certificate, /App/Component/Fabric]
}
StatusText: [<Freeform status text>]
}
Response
{
Resource:/App/System/Certificate
HQI {
Color: Yellow
Value: 2
}
StatusText: [Certificate x expires on <date>.]
}